Deprecate azure_service_bus #455
Conversation
azure_service_bus plugin has been moved to azure.azcollection.azure_service_bus and will be removed in a future release.
|
Label error. Requires exactly 1 of: bug, chore, enhancement, major, minor, patch, skip-changelog. Found: |
There was a problem hiding this comment.
We need to discuss and analyze this change and the desired behavior, ansible-rulebook, unlike ansible-core, does not support right now the deprecation capabilities that this PR assumes
cc @ptoscano
There was a problem hiding this comment.
Hi @p3ck,
thanks for approaching us about the Azure EDA event source.
I noted inline why the current PR cannot work: as also @Alex-Izquierdo wrote, there is no support in ansible-rulebook/eda-server for any of the module lifecycle feature that ansible-playbook supports. I think what only works is marking the EDA module as deprecated in its DOCUMENTATION block.
| dependencies: | ||
| azure.azcollection: ">=3.7.0" |
There was a problem hiding this comment.
I don't think this collection should start to pull other collections. Deprecating means that users should switch away from "something", while that "something" still works as-is until its removal.
| hosts: all | ||
| sources: | ||
| - ansible.eda.azure_service_bus: | ||
| - azure.azcollection.azure_service_bus: |
There was a problem hiding this comment.
I don't think this is correct: this example correctly refers to the module shipped in this collection, so it is valid until the module is shipped in the collection.
Most likely this rulebook ought to be copied together with the non-deprecated version of azure_service_bus, and the rulebook in that location ought to refer to the new location of the EDA source.
| azure_service_bus: | ||
| redirect: azure.azcollection.azure_service_bus | ||
| deprecation: | ||
| removal_version: 3.0.0 | ||
| warning_text: >- | ||
| azure_service_bus has been moved to azure.azcollection.azure_service_bus. | ||
| Please update your tasks. |
There was a problem hiding this comment.
This does not work: there is no support in ansible-rulebook for deprecating/renaming/removing content as documented here:
https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html
|
Hello, I was on PTO for the last few weeks so just getting back to this now. It doesn't seem like any of my changes to deprecate the module from here will work. Do you have any suggestion on how to proceed? Thanks, |
@p3ck I think that, as a short-term solution, we are going to deprecate it through documentation only. Enabling such deprecation behavior in ansible-rulebook would require a bigger effort, and I believe it’s not part of our short-term plans. What we can also do is print a deprecation warning message at the start of the module. |
3 participants
azure_service_bus plugin has been moved to
azure.azcollection.azure_service_bus and will be removed in a future release.
This is my first time deprecating a module that has moved so I may have missed something. Thank you